Store taskprocessing output files with extension to ease mimtype guessing by marcelklehr · Pull Request #61689 · nextcloud/server

marcelklehr · 2026-07-01T11:28:59Z

Summary

Currently, we have to guess the mime type entirely from the data which is sometimes hard. With this we allow synchronous providers to hint the file extension and mime type.

Also adds some needed attributes.

TODO

How should we allow ex apps to pass this information?

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) will be updated or is not required
Backports requested where applicable (ex: critical bugfixes)
Labels added where applicable (ex: bug/enhancement, 3. to review, feature component)
Milestone added for target branch/version (ex: 32.x for stable32)

AI (if applicable)

The content of this PR was partly or fully generated using AI

julien-nc

Lgtm 👍

Copilot

Pull request overview

This PR extends the TaskProcessing public API and implementation to better handle “file-shaped” task outputs by allowing providers (and ExApps uploads) to influence stored output filenames via extensions, with the goal of improving MIME type detection downstream. It also annotates several public TaskProcessing interfaces/data objects with #[Implementable] / #[Consumable] attributes.

Changes:

Introduces OCP\TaskProcessing\FileShaped and updates synchronous provider return type annotations to allow returning FileShaped values.
Extends output validation (EShapeType::validateOutputWithFileData) and output encapsulation (Manager::encapsulateOutputFileData) to accept file-shaped outputs.
Appends file extensions when storing uploaded/provider output data in AppData, and adds Implementable/Consumable attributes to several public APIs.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 14 comments.

Show a summary per file

File	Description
lib/public/TaskProcessing/SynchronousProviderOptions.php	Marks the options class as `#[Consumable]` for public API consumption.
lib/public/TaskProcessing/ShapeEnumValue.php	Marks the DTO as `#[Consumable]`.
lib/public/TaskProcessing/ShapeDescriptor.php	Marks the DTO as `#[Consumable]`.
lib/public/TaskProcessing/ITriggerableProvider.php	Marks provider interface as `#[Implementable]` (but `since` metadata needs correction).
lib/public/TaskProcessing/ITaskType.php	Marks task type interface as `#[Implementable]`.
lib/public/TaskProcessing/ISynchronousProvider.php	Marks interface as `#[Implementable]` and expands psalm return types to include `FileShaped`.
lib/public/TaskProcessing/ISynchronousOptionsAwareProvider.php	Marks interface as `#[Implementable]` and expands psalm return types to include `FileShaped`.
lib/public/TaskProcessing/IProvider.php	Marks provider interface as `#[Implementable]`.
lib/public/TaskProcessing/IInternalTaskType.php	Marks internal task type interface as `#[Implementable]` (minor formatting consistency).
lib/public/TaskProcessing/FileShaped.php	Adds new public DTO to carry file-shaped output data + metadata (extension/mime type).
lib/public/TaskProcessing/EShapeType.php	Updates output validation to allow `FileShaped` (but list validation currently has critical logic errors).
lib/private/TaskProcessing/Manager.php	Stores file outputs using provided extensions (but list branch currently clears unrelated output keys and needs extension normalization).
core/Controller/TaskProcessingApiController.php	Appends extension when storing ExApp uploaded files (needs extension sanitization/normalization).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…ype guessing Signed-off-by: Marcel Klehr <mklehr@gmx.net>

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Marcel Klehr <mklehr@gmx.net>

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

…erty Signed-off-by: Marcel Klehr <mklehr@gmx.net>

Assisted-by: ClaudeCode:claude-opus-4-8 Signed-off-by: Marcel Klehr <mklehr@gmx.net>

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

julien-nc

Lgtm. A few nitpicks.

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

kyteinsky · 2026-07-15T06:33:22Z

@@ -534,7 +535,8 @@ public function setFileContentsExApp(int $taskId): DataResponse {
 			if (!$handle) {
 				return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
 			}
-			$fileId = $this->setFileContentsInternal($handle);
+			$ext = pathinfo($file['name'], PATHINFO_EXTENSION);


Suggested change

$ext = pathinfo($file['name'], PATHINFO_EXTENSION);

$ext = pathinfo(($file['name'] ?? ''), PATHINFO_EXTENSION);

kyteinsky · 2026-07-15T06:54:39Z

-		if ($this === EShapeType::Image && !is_string($value)) {
+		if ($this === EShapeType::Image && !is_string($value) && !($value instanceof FileShaped && $value->getShapeType() === EShapeType::Image)) {
 			throw new ValidationException('Non-image item provided for Image slot');
 		}
-		if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
+		if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item) && !($item instanceof FileShaped && $item->getShapeType() === EShapeType::Image))) > 0)) {


maybe it would be nice to exact these checks in functions with separate ifs for different checks so they are easier to parse.
they could even be reused for the array checks then.

something along these lines but feel free to do it your way:

/** * Check whether a single value is valid file output data for the given shape type. * Accepts raw string data or a FileShaped wrapper whose shape type matches. */ private static function isValidFileData(mixed $value, EShapeType $expected): bool { if (is_string($value)) { return true; } return $value instanceof FileShaped && $value->getShapeType() === $expected; } /** * Check whether a value is a valid list of file output data items. */ private static function isValidFileDataList(mixed $value, EShapeType $scalarType): bool { if (!is_array($value)) { return false; } foreach ($value as $item) { if (!self::isValidFileData($item, $scalarType)) { return false; } } return true; }

and can be used like:

if ($this === EShapeType::Image && !self::isValidFileData($value, EShapeType::Image)) { throw new ValidationException('Non-image item provided for Image slot'); }

kyteinsky · 2026-07-15T07:03:01Z

 			throw new ValidationException('Non-file item provided for File slot');
 		}
-		if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
+		if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item) && !($item instanceof FileShaped && $item->getShapeType() === EShapeType::File))) > 0)) {
 			throw new ValidationException('Non-audio list item provided for ListOfFiles slot');


Suggested change

throw new ValidationException('Non-audio list item provided for ListOfFiles slot');

throw new ValidationException('Non-file list item provided for ListOfFiles slot');

kyteinsky · 2026-07-15T07:14:05Z

-	 * @psalm-return array<string, list<numeric|string>|numeric|string>
+	 * @psalm-return array<string, list<numeric|string|FileShaped>|numeric|string|FileShaped>


maybe it can be noted that FileShaped addition in the return type was made in 35.0.0
like in

server/lib/public/TaskProcessing/IManager.php

Line 55 in 0258837

* @since 31.0.0 Added the `showDisabled` argument.

kyteinsky · 2026-07-15T07:26:41Z

+	/**
+	 * @since 35.0.0
+	 */
+	public static function sanitizeExtension(string $ext): string {


the extension provider is within the trust boundary of ex-apps and php apps but it may not hurt to reject .php, .phar and .htaccess extensions

marcelklehr added this to the Nextcloud 35 milestone Jul 1, 2026

marcelklehr requested a review from a team as a code owner July 1, 2026 11:29

marcelklehr requested review from Altahrim and salmart-dev and removed request for a team July 1, 2026 11:29

marcelklehr added the 2. developing Work in progress label Jul 1, 2026

marcelklehr requested review from CarlSchwan and leftybournes July 1, 2026 11:29

marcelklehr added the feature: TaskProcessing label Jul 1, 2026

marcelklehr commented Jul 1, 2026

View reviewed changes

Comment thread lib/public/TaskProcessing/EShapeType.php Outdated

marcelklehr force-pushed the feat/taskprocessing-output-files-with-mimetypes branch from a499488 to 944e422 Compare July 1, 2026 12:07

marcelklehr requested review from Copilot and julien-nc July 1, 2026 12:08

marcelklehr added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Jul 1, 2026

Copilot started reviewing on behalf of marcelklehr July 1, 2026 12:08 View session

julien-nc approved these changes Jul 1, 2026

View reviewed changes

Copilot AI reviewed Jul 1, 2026

View reviewed changes

marcelklehr mentioned this pull request Jul 10, 2026

fix: Output shape validation will delete keys when there is a list of files #61962

Open

8 tasks

nextcloud-command added the AI assisted label Jul 14, 2026

marcelklehr and others added 10 commits July 14, 2026 12:25

feat(TaskProcessing): Store output files with extension to ease mimet…

f961edf

…ype guessing Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix: Add dot before file extension

1a5d599

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix(TaskProcessing): Add file extension for files uploaded from ex apps

de4de30

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix: Apply suggestions from code review

4e01aaa

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix(TaskProcessing): Fix EShapeType validation

9a983cc

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix(TaskProcessing): Fix file output validation

950ef2d

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix(TaskProcessing): Sanitize file extension and remove mimetype prop…

c5c7b98

…erty Signed-off-by: Marcel Klehr <mklehr@gmx.net>

test: Add TaskProcessing test for FileShaped output

980f236

Assisted-by: ClaudeCode:claude-opus-4-8 Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix: Fun cs:fix

a501416

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix: Fix psalm issue

b8db1f0

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

fix: Fix autoloaders

70e7fea

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

marcelklehr force-pushed the feat/taskprocessing-output-files-with-mimetypes branch from 8d2c8e2 to 70e7fea Compare July 14, 2026 10:26

julien-nc requested changes Jul 14, 2026

View reviewed changes

Comment thread lib/public/TaskProcessing/FileShaped.php Outdated

Comment thread lib/public/TaskProcessing/FileShaped.php Outdated

Comment thread lib/public/TaskProcessing/FileShaped.php

Comment thread lib/public/TaskProcessing/FileShaped.php Outdated

miaulalala reviewed Jul 14, 2026

View reviewed changes

Comment thread core/Controller/TaskProcessingApiController.php

marcelklehr requested review from julien-nc and miaulalala July 15, 2026 05:18

fix: Address review comments

326b94a

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

marcelklehr force-pushed the feat/taskprocessing-output-files-with-mimetypes branch from 3c6bd44 to 326b94a Compare July 15, 2026 05:50

kyteinsky reviewed Jul 15, 2026

View reviewed changes

	$ext = pathinfo($file['name'], PATHINFO_EXTENSION);
	$ext = pathinfo(($file['name'] ?? ''), PATHINFO_EXTENSION);

	throw new ValidationException('Non-audio list item provided for ListOfFiles slot');
	throw new ValidationException('Non-file list item provided for ListOfFiles slot');

		* @psalm-return array<string, list<numeric\|string>\|numeric\|string>
		* @psalm-return array<string, list<numeric\|string\|FileShaped>\|numeric\|string\|FileShaped>

Uh oh!

Uh oh!

Conversation

marcelklehr commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

TODO

Checklist

AI (if applicable)

Uh oh!

Uh oh!

julien-nc left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

julien-nc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kyteinsky Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

kyteinsky Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

kyteinsky Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

kyteinsky Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

kyteinsky Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

marcelklehr commented Jul 1, 2026 •

edited

Loading